This repository was archived by the owner on Jun 5, 2025. It is now read-only.
[DRAFT] Development Guide Review #1
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jyguyomarch
changed the title
stefankirchfeld
suggested changes
Dec 24, 2021
README.md
Outdated
| - implement the Web Client Bridge API in your web application | ||
|
|
||
| The following diagram shows a high level picture of how the Web Client is integrated into a web application and illustrates the two interfaces (Web Client API and Web Client Bridge) and their place in the integration. | ||
| The following diagram shows a high level process of how the Web Client is integrated into a web application and illustrates the two interfaces (Web Client API and Web Client Bridge) and their place in the integration. |
Contributor
There was a problem hiding this comment.
No, it's not a process diagram. It's really just an high level integration architecture.
Contributor
There was a problem hiding this comment.
Ok. can we instead say "The following diagram shows an overview of how...."
README.md
Outdated
| **NOTE** | ||
|
|
||
| Please note that the return type of each method can either be the documented type or a Promise resolving to that type, in case asynchronous processing is required. All Speech-To-Text related methods have to be declared with the `async` keyword because they are inherently assumed to be asynchronous. | ||
| Please note that the return type of each method can either be the documented type or a promise resolving to that type, in case asynchronous processing is required. All Speech-To-Text related methods have to be declared with the `async` keyword because they are inherently assumed to be asynchronous. |
Contributor
There was a problem hiding this comment.
In this case Promise should be capitalized but also be espaced with `` to indicate a JavaScript code type
README.md
Outdated
| The following Web Client Bridge API functions are related to integrating Speech-To-Text (STT) into the Web Client. These functions can be implemented to integrate any STT service into the Web Client. | ||
|
|
||
| The microphone button and its related UX controls will be enabled if the Web Client detects that STT is implemented in the bridge. | ||
| The microphone button and its related UX controls will be enabled if the Web Client detects the STT that is implemented in the bridge. |
Contributor
There was a problem hiding this comment.
not sure, this changes the meaning of the sentence. What I want to say is that Web Client detects the fact that STT is either implemented or not implemented.
Contributor
Author
|
Also wondering if a TOC (or 2 for each section) will help. Will try that later |
Contributor
Author
|
@stefankirchfeld I think this one is ready for your review and merge if it looks good to you |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ongoing review of the development guide before publication